docs: add installation and user guides - #31
Merged
Merged
Conversation
Signed-off-by: Hongsheng Liu <liuhongsheng4@huawei.com>
main absorbed the MVP merge (#28) and rewrote README.md around it, while this branch still described the MVP as living on the integration branch. Keep main's README as the body, add a Documentation section linking the new guides, and update installation.md / user-guide.md so they install from the default branch instead of integration/mvp-first-pr-watch (deep links become relative links to the docs now on main).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The README currently gives no installation or usage instructions. Add a source-install quickstart, an installation guide, and a user guide covering PR watches, authentication, runner controls, notifications, memory, optional inference, and troubleshooting.
The docs distinguish the current
mainscaffold from the full MVP in #28 and explicitly selectintegration/mvp-first-pr-watchwhen installing the MVP. No application code changes.Validation on Linux with Python 3.12:
82eb79a.661f4bae; all 8 first-use demo scenarios passed.git diff --check.